Relationship.involvesPerson - Code Metrics - Inspection of "remove text exclusion" - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c7ea8a...8a62cc )

by Justin

created 2017-01-31 19:15 UTC

Relationship.involvesPerson B

↳ Parent: src/core/Relationship.js

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
c	0
b	0
f	0
nc	6
nop	1
dl	0
loc	13
rs	8.8571

var GedcomX = require('../'),
    utils = require('../utils');
    
/**
 * A relationship.
 * 
 * @see {@link https://github.com/FamilySearch/gedcomx/blob/master/specifications/json-format-specification.md#relationship|GEDCOM X JSON Spec}
 * 
 * @class
 * @extends Subject
 * @param {Object} [json]

 */
var Relationship = function(json){
  
  // Protect against forgetting the new keyword when calling the constructor
  if(!(this instanceof Relationship)){
    return new Relationship(json);
  }
  
  // If the given object is already an instance then just return it. DON'T copy it.
  if(Relationship.isInstance(json)){
    return json;
  }
  
  this.init(json);

};

Relationship.prototype = Object.create(GedcomX.Subject.prototype);

Relationship._gedxClass = Relationship.prototype._gedxClass = 'GedcomX.Relationship';

Relationship.jsonProps = [
  'type',
  'person1',
  'person2',
  'facts'
];

/**
 * Check whether the given object is an instance of this class.
 * 
 * @param {Object} obj
 * @returns {Boolean}
 */
Relationship.isInstance = function(obj){
  return utils.isInstance(obj, this._gedxClass);
};

/**
 * Initialize from JSON
 * 
 * @param {Object}

 * @return {Relationship} this
 */
Relationship.prototype.init = function(json){
  
  GedcomX.Subject.prototype.init.call(this, json);
  
  if(json){
    this.setType(json.type);
    this.setPerson1(json.person1);
    this.setPerson2(json.person2);
    this.setFacts(json.facts);
  }
  return this;
};

/**
 * Get the relationship type
 * 
 * @returns {String} type
 */
Relationship.prototype.getType = function(){
  return this.type;
};

/**
 * Set the relationship type
 * 
 * @param {String} type
 * @returns {Relationship} This instance
 */
Relationship.prototype.setType = function(type){
  this.type = type;
  return this;
};

/**
 * Get person1 reference
 * 
 * @returns {ResourceReference}
 */
Relationship.prototype.getPerson1 = function(){
  return this.person1;
};

/**
 * Set the person1 reference
 * 
 * @param {ResourceReference} person1
 * @returns {Relationship} This instance
 */
Relationship.prototype.setPerson1 = function(person1){
  if(person1){
    this.person1 = GedcomX.ResourceReference(person1);
  }
  return this;
};

/**
 * Get person2 reference
 * 
 * @returns {ResourceReference}
 */
Relationship.prototype.getPerson2 = function(){
  return this.person2;
};

/**
 * Set the person1 reference
 * 
 * @param {ResourceReference} person2
 * @returns {Relationship} This instance
 */
Relationship.prototype.setPerson2 = function(person2){
  if(person2){
    this.person2 = GedcomX.ResourceReference(person2);
  }
  return this;
};

/**
 * Calculate whether a relationship involves a person
 * 
 * @param {Person|String} person Person object or person ID
 * @return {Boolean}
 */
Relationship.prototype.involvesPerson = function(person){
  if(person === undefined){
    return false;
  } else if(this.person1 && this.person2){
    return this.person1.matches(person) || this.person2.matches(person);
  } else if(this.person1){
    return this.person1.matches(person);
  } else if(this.person2){
    return this.person2.matches(person);
  } else {
    return false;
  }
};

/**
 * Given a person in this relationships, return the other person's resource reference.
 * 
 * @param {Person|String} person Person object or person ID
 * @return {ResourceReference}
 */
Relationship.prototype.getOtherPerson = function(person){
  return this.person1 && this.person1.matches(person) ? this.person2 : this.person1;
};

/**
 * Get the facts
 * 
 * @return {Fact[]}
 */
Relationship.prototype.getFacts = function(){
  return this.facts || [];
};

/**
 * Set the facts
 * 
 * @param {Fact[]|Object[]} facts
 * @returns {Relationship} This instance
 */
Relationship.prototype.setFacts = function(facts){
  return this._setArray(facts, 'facts', 'addFact');
};

/**
 * Add a fact
 * 
 * @param {Fact|Object} fact
 * @returns {Relationship} This instance
 */
Relationship.prototype.addFact = function(fact){
  return this._arrayPush(fact, 'facts', GedcomX.Fact);
};

/**
 * Export the object as JSON
 * 
 * @return {Object} JSON object
 */
Relationship.prototype.toJSON = function(){
  return this._toJSON(GedcomX.Subject, Relationship.jsonProps);
};

module.exports = Relationship;

1			var GedcomX = require('../'),
2			utils = require('../utils');
3
4			/**
5			* A relationship.
6			*
7			* @see {@link https://github.com/FamilySearch/gedcomx/blob/master/specifications/json-format-specification.md#relationship\|GEDCOM X JSON Spec}
8			*
9			* @class
10			* @extends Subject
11			* @param {Object} [json]
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `[json]` does not exist. Did you maybe forget to remove this comment? Loading history...
12			*/
13			var Relationship = function(json){
14
15			// Protect against forgetting the new keyword when calling the constructor
16			if(!(this instanceof Relationship)){
17			return new Relationship(json);
18			}
19
20			// If the given object is already an instance then just return it. DON'T copy it.
21			if(Relationship.isInstance(json)){
22			return json;
23			}
24
25			this.init(json);
			0 ignored issues – show Best Practice introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
26			};
27
28			Relationship.prototype = Object.create(GedcomX.Subject.prototype);
29
30			Relationship._gedxClass = Relationship.prototype._gedxClass = 'GedcomX.Relationship';
31
32			Relationship.jsonProps = [
33			'type',
34			'person1',
35			'person2',
36			'facts'
37			];
38
39			/**
40			* Check whether the given object is an instance of this class.
41			*
42			* @param {Object} obj
43			* @returns {Boolean}
44			*/
45			Relationship.isInstance = function(obj){
46			return utils.isInstance(obj, this._gedxClass);
47			};
48
49			/**
50			* Initialize from JSON
51			*
52			* @param {Object}
			0 ignored issues – show Documentation introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
53			* @return {Relationship} this
54			*/
55			Relationship.prototype.init = function(json){
56
57			GedcomX.Subject.prototype.init.call(this, json);
58
59			if(json){
60			this.setType(json.type);
61			this.setPerson1(json.person1);
62			this.setPerson2(json.person2);
63			this.setFacts(json.facts);
64			}
65			return this;
66			};
67
68			/**
69			* Get the relationship type
70			*
71			* @returns {String} type
72			*/
73			Relationship.prototype.getType = function(){
74			return this.type;
75			};
76
77			/**
78			* Set the relationship type
79			*
80			* @param {String} type
81			* @returns {Relationship} This instance
82			*/
83			Relationship.prototype.setType = function(type){
84			this.type = type;
85			return this;
86			};
87
88			/**
89			* Get person1 reference
90			*
91			* @returns {ResourceReference}
92			*/
93			Relationship.prototype.getPerson1 = function(){
94			return this.person1;
95			};
96
97			/**
98			* Set the person1 reference
99			*
100			* @param {ResourceReference} person1
101			* @returns {Relationship} This instance
102			*/
103			Relationship.prototype.setPerson1 = function(person1){
104			if(person1){
105			this.person1 = GedcomX.ResourceReference(person1);
106			}
107			return this;
108			};
109
110			/**
111			* Get person2 reference
112			*
113			* @returns {ResourceReference}
114			*/
115			Relationship.prototype.getPerson2 = function(){
116			return this.person2;
117			};
118
119			/**
120			* Set the person1 reference
121			*
122			* @param {ResourceReference} person2
123			* @returns {Relationship} This instance
124			*/
125			Relationship.prototype.setPerson2 = function(person2){
126			if(person2){
127			this.person2 = GedcomX.ResourceReference(person2);
128			}
129			return this;
130			};
131
132			/**
133			* Calculate whether a relationship involves a person
134			*
135			* @param {Person\|String} person Person object or person ID
136			* @return {Boolean}
137			*/
138			Relationship.prototype.involvesPerson = function(person){
139			if(person === undefined){
140			return false;
141			} else if(this.person1 && this.person2){
142			return this.person1.matches(person) \|\| this.person2.matches(person);
143			} else if(this.person1){
144			return this.person1.matches(person);
145			} else if(this.person2){
146			return this.person2.matches(person);
147			} else {
148			return false;
149			}
150			};
151
152			/**
153			* Given a person in this relationships, return the other person's resource reference.
154			*
155			* @param {Person\|String} person Person object or person ID
156			* @return {ResourceReference}
157			*/
158			Relationship.prototype.getOtherPerson = function(person){
159			return this.person1 && this.person1.matches(person) ? this.person2 : this.person1;
160			};
161
162			/**
163			* Get the facts
164			*
165			* @return {Fact[]}
166			*/
167			Relationship.prototype.getFacts = function(){
168			return this.facts \|\| [];
169			};
170
171			/**
172			* Set the facts
173			*
174			* @param {Fact[]\|Object[]} facts
175			* @returns {Relationship} This instance
176			*/
177			Relationship.prototype.setFacts = function(facts){
178			return this._setArray(facts, 'facts', 'addFact');
179			};
180
181			/**
182			* Add a fact
183			*
184			* @param {Fact\|Object} fact
185			* @returns {Relationship} This instance
186			*/
187			Relationship.prototype.addFact = function(fact){
188			return this._arrayPush(fact, 'facts', GedcomX.Fact);
189			};
190
191			/**
192			* Export the object as JSON
193			*
194			* @return {Object} JSON object
195			*/
196			Relationship.prototype.toJSON = function(){
197			return this._toJSON(GedcomX.Subject, Relationship.jsonProps);
198			};
199
200			module.exports = Relationship;

rootsdev / gedcomx-js

Push — master ( c7ea8a...8a62cc )

Relationship.involvesPerson B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like